DSTU2 QA Preview

This page is part of the FHIR Specification (v1.0.0: DSTU 2 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

C.1.1 StructureDefinition: SDCDE-DataElement

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/sdcde-dataelement

Sets expectations for data elements exchanged or maintained within data element registries according to requirements established by the structured data capture project

This profile was published on Mon, Apr 21, 2014 00:00+1000 as a draft by Health Level Seven International (Orders and Observations - Structured Data Capture).

C.1.1.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from DataElement.

Summary

Mandatory: 14 elements (+8 nested mandatory elements)
Must-Support: 80 elements
Fixed Value: 4 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element DataElement.mapping is sliced based on the value of uri
  • The element DataElement.element.mapping is sliced based on the value of identity

This structure is derived from DataElement.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DataElement I0..*DataElementinv-2: One and only one DataElement.code must have is-data-element-concept set to "true"
... url S1..1uri
... identifier S1..1Identifier
... version S1..1string
... name S1..1string
... status S1..1code
... experimental S0..1boolean
... publisher S1..1string
... contact S1..*BackboneElement
.... name S1..1string
.... telecom S1..1ContactPoint
.... 11179-de-contact-address S0..1AddressHow to mail contact
URL: http://hl7.org/fhir/StructureDefinition/11179-de-contact-address
Slice: Unordered, Open, by url
... date S0..1dateTime
... useContext S0..*CodeableConcept
.... 11179-de-classification-or-context S1..1codecontext | classification
URL: http://hl7.org/fhir/StructureDefinition/11179-de-classification-or-context
Slice: Unordered, Open, by url
... copyright S0..1string
... stringency S1..1codeFixed Value: comparable
... mapping SBackboneElementSlice: Unordered, Open, by uri
.... identity S1..1idFixed Value: objclass-prop
.... uri S1..1uriFixed Value: http://healthit.gov/sdc/objectclassproperty
.... name S0..1string
.... comments S0..1string
... mapping S I0..*BackboneElementinv-1: Property extension can only be specified if ObjectClass extension is present
.... identity S1..1id
.... uri S0..1uri
.... name S0..1string
.... comments S0..1string
... element S1..*ElementDefinition
.... path S
.... name S
.... label S
.... code SBinding: DataElement SDC Concept (extensible)
..... 11179-de-is-data-element-concept I0..1booleanIs code the DEC for the data element?
URL: http://hl7.org/fhir/StructureDefinition/11179-de-is-data-element-concept
Slice: Unordered, Open, by url
.... definition S1..1
.... comments S
.... requirements S
.... alias S
.... min S
.... max S
.... type S0..1
..... code S
.... defaultValue[x]
.... meaningWhenMissing
.... example[x] S
.... minValue[x] S
.... maxValue[x] S
.... maxLength S
.... condition S
.... constraint S
..... key S
..... requirements S
..... severity S
..... human S
..... xpath S
.... mustSupport 0..0
.... binding S
..... strength S
..... description S
..... valueSetReference S I1..1Reference(Structured Data Capture Data Element Exchange Value Set)inv-3: Must have data element permitted value concept map extension if and only if data element permitted value valueset extension is present
...... 11179-permitted-value-valueset S I0..1Reference(ValueSet)Permitted values
URL: http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset
Slice: Unordered, Open, by url
...... 11179-permitted-value-conceptmap S I0..1Reference(ConceptMap)Mapping from permitted to transmitted
URL: http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap
.... mapping S ISlice: Unordered, Open, by identity
..... 11179-objectClass S I1..1CodingObject Class
URL: http://hl7.org/fhir/StructureDefinition/11179-objectClass
Slice: Unordered, Open, by url
...... valueCoding S1..1CodingBinding: DataElement SDC Concept (extensible)
..... 11179-objectClassProperty S I1..1CodingObject Class Property
URL: http://hl7.org/fhir/StructureDefinition/11179-objectClassProperty
...... valueCoding S1..1CodingBinding: DataElement SDC Concept (extensible)
..... identity SidFixed Value: objclass-prop
..... map S1..1
..... 11179-objectClass S I1..1CodingObject Class
URL: http://hl7.org/fhir/StructureDefinition/11179-objectClass
Slice: Unordered, Open, by url
...... valueCoding S1..1CodingBinding: DataElement SDC Concept (extensible)
..... 11179-objectClassProperty S I1..1CodingObject Class Property
URL: http://hl7.org/fhir/StructureDefinition/11179-objectClassProperty
...... valueCoding S1..1CodingBinding: DataElement SDC Concept (extensible)
.... mapping S I0..*
..... identity Sid
..... language S
..... map S
..... elementdefinition-equivalence S0..1codeequivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-equivalence
Slice: Unordered, Open, by url
.... elementdefinition-question S2..*stringPrompt for element phrased as question
URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-question
Slice: Unordered, Open, by url
.... elementdefinition-allowedUnits S0..1CodeableConcept, Reference(ValueSet)Units to use for measured value
URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits
.... minLength S0..1integerAt least this many characters
URL: http://hl7.org/fhir/StructureDefinition/minLength
.... regex S0..1stringRegular expression pattern
URL: http://hl7.org/fhir/StructureDefinition/regex
.... entryFormat S0..1stringUser prompt for format
URL: http://hl7.org/fhir/StructureDefinition/entryFormat
.... maxDecimalPlaces S0..1integerMaximum digits after decimal
URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces
... 11179-de-effective-period S0..1PeriodWhen data element is "valid"
URL: http://hl7.org/fhir/StructureDefinition/11179-de-effective-period
Slice: Unordered, Open, by url
... 11179-de-document-reference S0..*Reference(DocumentReference)Pointer to document related to data element
URL: http://hl7.org/fhir/StructureDefinition/11179-de-document-reference
... 11179-de-administrative-status S1..1CodeableConceptStatus of internal processing
URL: http://hl7.org/fhir/StructureDefinition/11179-de-administrative-status
... 11179-de-change-description S0..1stringWhat's changed since the last "business" version?
URL: http://hl7.org/fhir/StructureDefinition/11179-de-change-description
... 11179-de-submitter-org S1..1Reference(Organization)Who submitted data element to registry
URL: http://hl7.org/fhir/StructureDefinition/11179-de-submitter-org
... 11179-de-registry-org S1..1Reference(Organization)Organization responsible for registry
URL: http://hl7.org/fhir/StructureDefinition/11179-de-registry-org

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DataElement I0..*DataElementResource data element
inv-2: One and only one DataElement.code must have is-data-element-concept set to "true"
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... 11179-de-effective-period S0..1PeriodExtension
URL: http://hl7.org/fhir/StructureDefinition/11179-de-effective-period
... 11179-de-document-reference S0..*Reference(DocumentReference)Extension
URL: http://hl7.org/fhir/StructureDefinition/11179-de-document-reference
... 11179-de-administrative-status S1..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/11179-de-administrative-status
... 11179-de-change-description S0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/11179-de-change-description
... 11179-de-submitter-org S1..1Reference(Organization)Extension
URL: http://hl7.org/fhir/StructureDefinition/11179-de-submitter-org
... 11179-de-registry-org S1..1Reference(Organization)Extension
URL: http://hl7.org/fhir/StructureDefinition/11179-de-registry-org
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url S ∑1..1uriGlobally unique logical id for data element
... identifier S ∑1..1IdentifierLogical id to reference this data element
... version S ∑1..1stringLogical id for this version of the data element
... name S ∑1..1stringDescriptive label for this element definition
... status ?! S∑1..1codedraft | active | retired
Binding: ConformanceResourceStatus (required)
... experimental S ∑0..1booleanIf for testing purposes, not real usage
... publisher S ∑1..1stringName of the publisher (Organization or individual)
... contact S ∑1..*BackboneElementContact details of the publisher
.... 11179-de-contact-address S0..1AddressExtension
URL: http://hl7.org/fhir/StructureDefinition/11179-de-contact-address
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... name S ∑1..1stringName of a individual to contact
.... telecom S ∑1..1ContactPointContact details for individual or publisher
... date S ∑0..1dateTimeDate for this version of the data element
... useContext S ∑0..*CodeableConceptContent intends to support these contexts
Binding: Context of Use ValueSet (extensible)
.... 11179-de-classification-or-context S1..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/11179-de-classification-or-context
.... coding ∑0..*CodingCode defined by a terminology system
.... text ∑0..1stringPlain text representation of the concept
... copyright S0..1stringUse and/or Publishing restrictions
... stringency S ∑1..1codecomparable | fully-specified | equivalent | convertable | scaleable | flexible
Binding: DataElementStringency (required)
Fixed Value: comparable
... mapping BackboneElementExternal specification mapped to
Slice: Unordered, Open, by uri
... mapping S1..1BackboneElementExternal specification mapped to
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identity S1..1idInternal id when this mapping is used
Fixed Value: objclass-prop
.... uri S1..1uriIdentifies what this mapping refers to
Fixed Value: http://healthit.gov/sdc/objectclassproperty
.... name S0..1stringNames what this mapping refers to
.... comments S0..1stringVersions, Issues, Scope limitations etc
... mapping S I0..*BackboneElementExternal specification mapped to
inv-1: Property extension can only be specified if ObjectClass extension is present
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identity S1..1idInternal id when this mapping is used
.... uri S0..1uriIdentifies what this mapping refers to
.... name S0..1stringNames what this mapping refers to
.... comments S0..1stringVersions, Issues, Scope limitations etc
... element S ∑I1..*ElementDefinitionDefinition of element
dae-1: No base allowed
dae-2: No slicing allowed

doco Documentation for this format

todo

This structure is derived from DataElement.

Summary

Mandatory: 14 elements (+8 nested mandatory elements)
Must-Support: 80 elements
Fixed Value: 4 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element DataElement.mapping is sliced based on the value of uri
  • The element DataElement.element.mapping is sliced based on the value of identity

Differential View

This structure is derived from DataElement.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DataElement I0..*DataElementinv-2: One and only one DataElement.code must have is-data-element-concept set to "true"
... url S1..1uri
... identifier S1..1Identifier
... version S1..1string
... name S1..1string
... status S1..1code
... experimental S0..1boolean
... publisher S1..1string
... contact S1..*BackboneElement
.... name S1..1string
.... telecom S1..1ContactPoint
.... 11179-de-contact-address S0..1AddressHow to mail contact
URL: http://hl7.org/fhir/StructureDefinition/11179-de-contact-address
Slice: Unordered, Open, by url
... date S0..1dateTime
... useContext S0..*CodeableConcept
.... 11179-de-classification-or-context S1..1codecontext | classification
URL: http://hl7.org/fhir/StructureDefinition/11179-de-classification-or-context
Slice: Unordered, Open, by url
... copyright S0..1string
... stringency S1..1codeFixed Value: comparable
... mapping SBackboneElementSlice: Unordered, Open, by uri
.... identity S1..1idFixed Value: objclass-prop
.... uri S1..1uriFixed Value: http://healthit.gov/sdc/objectclassproperty
.... name S0..1string
.... comments S0..1string
... mapping S I0..*BackboneElementinv-1: Property extension can only be specified if ObjectClass extension is present
.... identity S1..1id
.... uri S0..1uri
.... name S0..1string
.... comments S0..1string
... element S1..*ElementDefinition
.... path S
.... name S
.... label S
.... code SBinding: DataElement SDC Concept (extensible)
..... 11179-de-is-data-element-concept I0..1booleanIs code the DEC for the data element?
URL: http://hl7.org/fhir/StructureDefinition/11179-de-is-data-element-concept
Slice: Unordered, Open, by url
.... definition S1..1
.... comments S
.... requirements S
.... alias S
.... min S
.... max S
.... type S0..1
..... code S
.... defaultValue[x]
.... meaningWhenMissing
.... example[x] S
.... minValue[x] S
.... maxValue[x] S
.... maxLength S
.... condition S
.... constraint S
..... key S
..... requirements S
..... severity S
..... human S
..... xpath S
.... mustSupport 0..0
.... binding S
..... strength S
..... description S
..... valueSetReference S I1..1Reference(Structured Data Capture Data Element Exchange Value Set)inv-3: Must have data element permitted value concept map extension if and only if data element permitted value valueset extension is present
...... 11179-permitted-value-valueset S I0..1Reference(ValueSet)Permitted values
URL: http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset
Slice: Unordered, Open, by url
...... 11179-permitted-value-conceptmap S I0..1Reference(ConceptMap)Mapping from permitted to transmitted
URL: http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap
.... mapping S ISlice: Unordered, Open, by identity
..... 11179-objectClass S I1..1CodingObject Class
URL: http://hl7.org/fhir/StructureDefinition/11179-objectClass
Slice: Unordered, Open, by url
...... valueCoding S1..1CodingBinding: DataElement SDC Concept (extensible)
..... 11179-objectClassProperty S I1..1CodingObject Class Property
URL: http://hl7.org/fhir/StructureDefinition/11179-objectClassProperty
...... valueCoding S1..1CodingBinding: DataElement SDC Concept (extensible)
..... identity SidFixed Value: objclass-prop
..... map S1..1
..... 11179-objectClass S I1..1CodingObject Class
URL: http://hl7.org/fhir/StructureDefinition/11179-objectClass
Slice: Unordered, Open, by url
...... valueCoding S1..1CodingBinding: DataElement SDC Concept (extensible)
..... 11179-objectClassProperty S I1..1CodingObject Class Property
URL: http://hl7.org/fhir/StructureDefinition/11179-objectClassProperty
...... valueCoding S1..1CodingBinding: DataElement SDC Concept (extensible)
.... mapping S I0..*
..... identity Sid
..... language S
..... map S
..... elementdefinition-equivalence S0..1codeequivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-equivalence
Slice: Unordered, Open, by url
.... elementdefinition-question S2..*stringPrompt for element phrased as question
URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-question
Slice: Unordered, Open, by url
.... elementdefinition-allowedUnits S0..1CodeableConcept, Reference(ValueSet)Units to use for measured value
URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits
.... minLength S0..1integerAt least this many characters
URL: http://hl7.org/fhir/StructureDefinition/minLength
.... regex S0..1stringRegular expression pattern
URL: http://hl7.org/fhir/StructureDefinition/regex
.... entryFormat S0..1stringUser prompt for format
URL: http://hl7.org/fhir/StructureDefinition/entryFormat
.... maxDecimalPlaces S0..1integerMaximum digits after decimal
URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces
... 11179-de-effective-period S0..1PeriodWhen data element is "valid"
URL: http://hl7.org/fhir/StructureDefinition/11179-de-effective-period
Slice: Unordered, Open, by url
... 11179-de-document-reference S0..*Reference(DocumentReference)Pointer to document related to data element
URL: http://hl7.org/fhir/StructureDefinition/11179-de-document-reference
... 11179-de-administrative-status S1..1CodeableConceptStatus of internal processing
URL: http://hl7.org/fhir/StructureDefinition/11179-de-administrative-status
... 11179-de-change-description S0..1stringWhat's changed since the last "business" version?
URL: http://hl7.org/fhir/StructureDefinition/11179-de-change-description
... 11179-de-submitter-org S1..1Reference(Organization)Who submitted data element to registry
URL: http://hl7.org/fhir/StructureDefinition/11179-de-submitter-org
... 11179-de-registry-org S1..1Reference(Organization)Organization responsible for registry
URL: http://hl7.org/fhir/StructureDefinition/11179-de-registry-org

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DataElement I0..*DataElementResource data element
inv-2: One and only one DataElement.code must have is-data-element-concept set to "true"
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... 11179-de-effective-period S0..1PeriodExtension
URL: http://hl7.org/fhir/StructureDefinition/11179-de-effective-period
... 11179-de-document-reference S0..*Reference(DocumentReference)Extension
URL: http://hl7.org/fhir/StructureDefinition/11179-de-document-reference
... 11179-de-administrative-status S1..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/11179-de-administrative-status
... 11179-de-change-description S0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/11179-de-change-description
... 11179-de-submitter-org S1..1Reference(Organization)Extension
URL: http://hl7.org/fhir/StructureDefinition/11179-de-submitter-org
... 11179-de-registry-org S1..1Reference(Organization)Extension
URL: http://hl7.org/fhir/StructureDefinition/11179-de-registry-org
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url S ∑1..1uriGlobally unique logical id for data element
... identifier S ∑1..1IdentifierLogical id to reference this data element
... version S ∑1..1stringLogical id for this version of the data element
... name S ∑1..1stringDescriptive label for this element definition
... status ?! S∑1..1codedraft | active | retired
Binding: ConformanceResourceStatus (required)
... experimental S ∑0..1booleanIf for testing purposes, not real usage
... publisher S ∑1..1stringName of the publisher (Organization or individual)
... contact S ∑1..*BackboneElementContact details of the publisher
.... 11179-de-contact-address S0..1AddressExtension
URL: http://hl7.org/fhir/StructureDefinition/11179-de-contact-address
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... name S ∑1..1stringName of a individual to contact
.... telecom S ∑1..1ContactPointContact details for individual or publisher
... date S ∑0..1dateTimeDate for this version of the data element
... useContext S ∑0..*CodeableConceptContent intends to support these contexts
Binding: Context of Use ValueSet (extensible)
.... 11179-de-classification-or-context S1..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/11179-de-classification-or-context
.... coding ∑0..*CodingCode defined by a terminology system
.... text ∑0..1stringPlain text representation of the concept
... copyright S0..1stringUse and/or Publishing restrictions
... stringency S ∑1..1codecomparable | fully-specified | equivalent | convertable | scaleable | flexible
Binding: DataElementStringency (required)
Fixed Value: comparable
... mapping BackboneElementExternal specification mapped to
Slice: Unordered, Open, by uri
... mapping S1..1BackboneElementExternal specification mapped to
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identity S1..1idInternal id when this mapping is used
Fixed Value: objclass-prop
.... uri S1..1uriIdentifies what this mapping refers to
Fixed Value: http://healthit.gov/sdc/objectclassproperty
.... name S0..1stringNames what this mapping refers to
.... comments S0..1stringVersions, Issues, Scope limitations etc
... mapping S I0..*BackboneElementExternal specification mapped to
inv-1: Property extension can only be specified if ObjectClass extension is present
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identity S1..1idInternal id when this mapping is used
.... uri S0..1uriIdentifies what this mapping refers to
.... name S0..1stringNames what this mapping refers to
.... comments S0..1stringVersions, Issues, Scope limitations etc
... element S ∑I1..*ElementDefinitionDefinition of element
dae-1: No base allowed
dae-2: No slicing allowed

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

C.1.1.2 Terminology Bindings

PathNameConformanceValueSet
DataElement.language?extrequiredhttp://tools.ietf.org/html/bcp47
DataElement.statusConformanceResourceStatusrequiredConformanceResourceStatus
DataElement.useContextContext of Use ValueSetextensibleContext of Use ValueSet
DataElement.stringencyDataElementStringencyrequiredDataElementStringency

C.1.1.3 Constraints

IdPathDetailsRequirements
inv-2DataElementOne and only one DataElement.code must have is-data-element-concept set to "true"
XPath: count(f:code/f:extension[@uri='http://hl7.org/fhir/StructureDefinition/11179-de-is-data-element-concept'])=1
inv-1DataElement.mappingProperty extension can only be specified if ObjectClass extension is present
XPath: exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/11179-objectClass']) or not(exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/11179-property']))
inv-1DataElement.mappingProperty extension can only be specified if ObjectClass extension is present
XPath: exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/11179-objectClass']) or not(exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/11179-property']))
inv-1DataElement.mappingProperty extension can only be specified if ObjectClass extension is present
XPath: exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/11179-objectClass']) or not(exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/11179-property']))
dae-1DataElement.elementNo base allowed
XPath: not(exists(f:base))
dae-2DataElement.elementNo slicing allowed
XPath: not(exists(f:slicing))
.